Get customers

GET /api/v1/Customers/get-all

Description

This endpoint is used to retrieve customers from the database based on search criteria.

Tags: Customers

URL:
/api/v{version}/Customers/get-all

ApiKey:
No API key required

Content-Type:
No request body

Query Parameters:
SearchText: string, optional (nullable)
TenantId: string, required (format: uuid)
PageNumber: integer, required (format: int32)
PageSize: integer, required (format: int32)
version: string, required
Accept-Language: header, optional, change the default response message language from English (en) to French (fr) or English (en)

Response:
Success, returns the list of customers.

Error Codes:
400: Bad Request
404: Resource not found
500: Internal server error

Example:

GET /api/v1/Customers/get-all?SearchText=example&TenantId=abcd-1234-efgh-5678&PageNumber=1&PageSize=10&Accept-Language=fr

/api/v1/Customers/get-all?SearchText=<string>&TenantId=<uuid>&PageNumber=<integer>&PageSize=<integer>

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
SearchText	<string>
TenantId	<uuid>
PageNumber	<integer>
PageSize	<integer>

Response: 200

{
  "pageNumber": `<integer>`,
  "pageSize": `<integer>`,
  "total": `<integer>`,
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": [
    {
      "name": `<string>`,
      "lastLogin": `<dateTime>`,
      "kycStatus": `<string>`,
      "kycTier": `<string>`,
      "userId": `<string>`,
      "profileId": `<uuid>`,
      "accounts": [
        {
          "id": `<uuid>`,
          "ownerId": `<uuid>`,
          "accountId": `<string>`,
          "accountName": `<string>`,
          "accountBIC": `<string>`,
          "accountType": `<string>`,
          "type": `<string>`,
          "currency": `<string>`,
          "availableBalance": `<double>`,
          "ledgerBalance": `<double>`,
          "nubanOrIban": `<string>`,
          "purpose": `<string>`,
          "tenantId": `<uuid>`,
          "lastTransaction": `<dateTime>`,
          "status": `<string>`
        },
        {
          "id": `<uuid>`,
          "ownerId": `<uuid>`,
          "accountId": `<string>`,
          "accountName": `<string>`,
          "accountBIC": `<string>`,
          "accountType": `<string>`,
          "type": `<string>`,
          "currency": `<string>`,
          "availableBalance": `<double>`,
          "ledgerBalance": `<double>`,
          "nubanOrIban": `<string>`,
          "purpose": `<string>`,
          "tenantId": `<uuid>`,
          "lastTransaction": `<dateTime>`,
          "status": `<string>`
        }
      ]
    },
    {
      "name": `<string>`,
      "lastLogin": `<dateTime>`,
      "kycStatus": `<string>`,
      "kycTier": `<string>`,
      "userId": `<string>`,
      "profileId": `<uuid>`,
      "accounts": [
        {
          "id": `<uuid>`,
          "ownerId": `<uuid>`,
          "accountId": `<string>`,
          "accountName": `<string>`,
          "accountBIC": `<string>`,
          "accountType": `<string>`,
          "type": `<string>`,
          "currency": `<string>`,
          "availableBalance": `<double>`,
          "ledgerBalance": `<double>`,
          "nubanOrIban": `<string>`,
          "purpose": `<string>`,
          "tenantId": `<uuid>`,
          "lastTransaction": `<dateTime>`,
          "status": `<string>`
        },
        {
          "id": `<uuid>`,
          "ownerId": `<uuid>`,
          "accountId": `<string>`,
          "accountName": `<string>`,
          "accountBIC": `<string>`,
          "accountType": `<string>`,
          "type": `<string>`,
          "currency": `<string>`,
          "availableBalance": `<double>`,
          "ledgerBalance": `<double>`,
          "nubanOrIban": `<string>`,
          "purpose": `<string>`,
          "tenantId": `<uuid>`,
          "lastTransaction": `<dateTime>`,
          "status": `<string>`
        }
      ]
    }
  ]
}